Index

api/v1/stock/{stockno}/prices

Path: api/v1/stock/{stockno}/prices

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

The resource type for this endpoint is StockPrices
The identifier is stockNo-stockPriceId

The StockPrices resource type attributes are as follows:

{
The internal price id used to identify the price.
"stockPriceId":integer
"priceLevel":string
"priceCalcMethod":string
"basePriceLevel":string
"currencyCode":string
"taxCode":string
The internal branch number used to identify the branch. This will only be returned if branch is enabled.
optional
"branchNo":integer Note: Will not be returned in the response if value is null.
The branch code. This will only be returned if branch is enabled.
"branchCode":string Note: Will not be returned in the response if value is null.
"discountPerc":number
"priceExcl":number
"priceIncl":number
"priceBreaks": [{
"qtyGreaterOrEqual":number
"discountPerc":number
"priceExcl":number
"priceIncl":number
}]
}

Example GET (Return all)

Path: api/v1/stock/10/prices

Response:

{
    "data": [
        {
            "id": "10-123",
            "type": "StockPrices",
            "attributes": {
				"stockPriceId": 123,
                "priceLevel": "1-Retail",
                "priceCalcMethod": "List - Percent",
                "basePriceLevel": "",
                "currencyCode": "AUD",
                "taxCode": "G",
                "discountPerc": 0.0,
                "priceExcl": 44.37,
                "priceIncl": 48.807
            }
        },
        {
            "id": "10-129",
            "type": "StockPrices",
            "attributes": {
				"stockPriceId": 129,
                "priceLevel": "3-Do & Charge",
                "priceCalcMethod": "List - Percent",
                "basePriceLevel": "",
                "currencyCode": "AUD",
                "taxCode": "G",
                "discountPerc": 0.0,
                "priceExcl": 44.37,
                "priceIncl": 48.807
            }
        }
	]
}

Example GET (Return specific)

Path: api/v1/stock/10/prices/10-129

Response:

{
    "data": {
		"id": "10-129",
		"type": "StockPrices",
		"attributes": {
			"stockPriceId": 129,
			"priceLevel": "3-Do & Charge",
			"priceCalcMethod": "List - Percent",
			"basePriceLevel": "",
			"currencyCode": "AUD",
			"taxCode": "G",
			"discountPerc": 0.0,
			"priceExcl": 44.37,
			"priceIncl": 48.807
		}
	}
}

Generated from Jim2 version 4.6.9804.70